BBS Toolkit/BBS Toolkit.iso/tag_bbs/nlog27.zip/NEWLOG.DOC

Text File | 1993-03-09 | 28KB | 616 lines

════════════════════════════════════════════════════════════════════════════════
                NewLog: THE alternate callers log for TAG v2.6d.

                              -=< Version 2.7 >=-

              Written under the TNT software label by Joe McElmeel.

════════════════════════════════════════════════════════════════════════════════

     Subject                                                    Search For
    -----------------------------------------------------------------------
|    The general features of NewLog ............................... 0A
|    How to upgrade from v2.6 ..................................... 0B
     Warranty and compatibility information ....................... 0C
     Distribution information ..................................... 0D
|    First time setup information ................................. 0E
     Explanation of all the features .............................. 0F
|    What to look for in future releases .......................... 0G
|    Support information .......................................... 0H
|    Other TNT Software Products .................................. 0I
     Contacting the authors ....................................... 0J
|    Acknowledgements ............................................. 0K
|    A final note about the error file ............................ 0L

   "|" denotes that this section has been updated since Version 2.6 Standard.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ FEATURES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0A░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

        o NewLog is 100% *FREEWARE*
        o Supports DESQview and MicroSoft Windows multi-taskers.
        o No messy text configuration files to play with.
        o Includes a fully-featured, built-in Setup program.
        o Configurable colors in the log (for each node, optionally).
        o Uses TAG's built-in Control-P color codes in its logging.
        o Fully supports Multi-Node systems, and uses file sharing/locking.
        o Support for locked COM ports & baud rates 300-57600.
        o Flexible command line parameters.
        o Configurable path & filename to write the output file to.
        o Supports a banner file to insert at the start of the log.
        o Internal comment/event logging feature.
        o Can log in two separate formats - columns and normal.
        o Can override the baud rate from CALLERS.LOG if you want to.
        o Optionally choose not to log keyboard logons.
        o Optionally choose not to log users with an SL of 255.
        o Optionally add an #ABORT OFF at the top of the log file.
        o Written and compiled in Borland's Turbo Pascal 7.0.
        o Now supports multiple TAG centering codes, some were incompatible.
        o If an error occurs, NewLog writes it to a text file with time/date!
        o Can append pauses at the end of the callers log.

 For a complete list of revisions, see REVISION.DOC included with the archive.
 Yes, folks, I forgot it last time.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ UPGRADING FROM OLDER VERSIONS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0B░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

Version 2.6:
-----------

        I'd advise taking advatage of the new enviornmental variable feature.
You can set an enviornmental variable "NEWLOG" to point to your path that has
the NLOG?.DAT files and (if you're a Beta site) your pre-release key file.

Example:

(AUTOEXEC.BAT)

@ECHO OFF
PROMPT $p$g
SET NEWLOG=C:\BBS\                   <--- Trailing backslash doesn't matter.
    ^^^^^^
    Must be in caps!

        Or you can simply set the variable in each batch file, then set it to
"" at the end of it (The reason for this feature is so you don't have to keep
CD'ing to the directory that contains your setup files and key each time you
execute NewLog).

        If you're upgrading from v2.6, simply enter the Setup program by exec-
uting NewLog with a "-Nx -S" command line. Where "x" is the number/character of
your NLOG?.DAT file(s). Then you have to quit by hitting Q in order to update
the data file.

        The new features include the option of adding a pause on the end of the
log, which may come in useful for SysOps that have ANSI menus; thanks to Alpha
site Jonathan Blair (1:2605/630) for the idea! Also, you can now CHOOSE which
centering code you want NewLog to use. This is useful for systems where ^B did
not work and drew a little smiley face on the screen.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ WARRANTY / COMPATIBILITY ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0C░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

   This product is provided "as is" without warranty of any kind.  The entire
risk as to the results and performance of the program is assumed by you.
Futhermore, I, the author do not warrant, guarantee, or make any represent-
tions regarding the use of, or the results of the use of the program, and you
rely on the program and results solely at your own risk. I the author cannot
accept responsibility for system damage, loss of profit, or any other special,
incidental, or consequential damages resulting from the use or inability to
use this product.

   However, we will be more than willing to support you, and help figure out
any problems that you may have with out program(s).

   NewLog has been compressed with a registered version of PKLITE by PKWARE,
with the extra compression switch, to ensure you there has been no viruses
inserted into the software, and this is, in fact, authentic.

   NewLog has been tested on a very wide range of systems, some running Net-
works, some running multi-taskers, and "average Joe" systems like mine. :)

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ DISTRIBUTION INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0D░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

   You are free, in fact encouraged, to distribute the software to anyone that
runs a TAG system, provided that all files contained in this original archive
are distributed in their original unmodified state.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ SETUP INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0E░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

   Make sure you have NEWLOG.EXE from the archive in Node 1's Main BBS
directory where your STATUS.DAT file for Node 1 resides.

   Enter the Setup program by running NewLog with a command line of "-Nx -S".
"x" is the node number for the setup data file that it will create. The default
values are those used on The Galaxy BBS, and several other NewLog Beta sites.

   Simply choose the option(s) on the menu that you wish to change; most will be
self-explanatory. You will probably *HAVE* to change at least the paths section.

Explanation of non self-explanatory options:
-------------------------------------------

 Properize comments   : Set this to "Yes" if you want NewLog to capitalize the
                        first character of each word and put everything else in
                        lower case when logging comments.

 Use alternate string : Set this to "Yes" if you want NewLog to take advantage
                        of this great new feature. See section 0F, "EXPLANATION
                        OF ALL FEATURES AVAILABLE" for more details.

 Use / Node x         : Set this to "Yes" if you want NewLog to append a "/
                        Node <Node Number>" after where it says your BBS' name
                        in the header of the log. Some systems have "BBS Name
                        / Node x" as their standard system name; that's why I
                        made this an option.

 Centering type to use: This is the character that you want NewLog to use to
                        center strings. Some system's, for some reason, can't
                        utilize the "^B" or "~*" centering codes -- if that's
                        the case use "Spaces" whre it will simply use spaces
                        and not ^B or ~* codes.

 Centering on banner  : This is the character that you want NewLog to use to
                        center the lines of a banner file, if used. You may not
                        want to do this if you already have it centered, etc.

 Add pause at end of..: This tells NewLog whether or not to add a Control-P
                        character at the end of the log; this may come in hand-
                        y for systems with ANSI menus that clear the screen.

 File to read banner  : This is a plain ASCII text file located in the Main BBS
                        directory that can be read in (optionally) that will dis-
                        play a phrase, some SDR codes, graphics, or anything you
                        wish right before it displays the log of callers for the
                        day. It can be of unlimited length.

 File for old logs    : This is where the old callers log files are written to if
                        you selected Rename for the option that asks what to do
                        with the old logs.

   NewLog worked with and without SHARE.EXE loaded, but I think it would be
wise to load it, especially in a multi-node environment. NewLog detects SHARE,
and is fully aware of it. There have been no reported problems loading it high
with QEMM or similar drivers.

        I'd advise taking advatage of the new enviornmental variable feature.
You can set an enviornmental variable "NEWLOG" to point to your path that has
the NLOG?.DAT files and (if you're a Beta site) your pre-release key file.

Example:

(AUTOEXEC.BAT)

@ECHO OFF
PROMPT $p$g
SET NEWLOG=C:\BBS\                   <--- Trailing backslash doesn't matter.
    ^^^^^^
    Must be in caps!

        Or you can simply set the variable in each batch file, then set it to
"" at the end of it (The reason for this feature is so you don't have to keep
CD'ing to the directory that contains your setup files and key each time you
execute NewLog).

   You may use the sample LOGON.NL file in this archive, simply by placing it
in the Main BBS Directory and renaming it to LOGON.BAT from LOGON.NL for a
faster setup if, however, you already have a LOGON.BAT file set-up, then you
would simply edit your LOGON.BAT file (for this node) in your Main BBS
directory and add the following line to it:

NEWLOG -Nx -C%3     (Where "x" is the node number of the setup file used!)
         ^   ^
         |   |
         +----------------- NOTE: *NO* spaces here.

  (%3 being the user number variable to read from TAG's USER.LST file found in
your Multi-Node Directory, or if you are single node, in your Main Data Files
Files directory).

   Now, Enter TAG's Menu Editor, via Conrtol-Q from the TAG Wait Screen and/or
from the system after you've logged on (Dependinng on how you have it
set up). See T.A.G.'s documentation for more details.

   In the menu editor, enter your main menu (or the menu with (L)og of Callers
set-up on it), and edit the (L) command. You want a program key of "!" (Without
the quotation marks) and a program data of "@CALL_LOG". This tells TAG to look
for CALL_LOG.MSG in the Alternate Text Files Directory (Where CALL_LOG.MSG is
the configurable filename for the log file). You should have all configuration
files for each node pointing to the same directory -- your shared AFILES
directory. Or if you want it in your Main Data files directory (usually under
a single node system), have the program data the same, but omit the "@".

(Please note, that when we mention "CALL_LOG.MSG" or "CALL_LOG", we mean the
 configurable filename to write the log to. The name is now fully configurable,
 it's just that "CALL_LOG" is the default filename used.)

   It looks exactly like this:

Menu name       : ((( The Galaxy BBS Main Menu ))) #1
Command number  : 12
1. Long desc.   : [L]og of today's callers
2. Short desc.  : [L]og Callers
3. Key          : L
4. General SL   : 10
5. AR flag      : @
6. Program key  : !
7. Program data : "@CALL_LOG"
F. Flags        : SL access check, GSL and AR, Normal Command, No Linking

Commands on this menu: 28

Command Edit: (1-7,F,[,],B,J,Q,T,?):

   That's pretty much it for set-up, once you get used to it and/or receive
some feedback from your users you may want to change the default colors.

   Also note, that you will see the NewLog screen pop up as a user is logging
on and TAG is going through its LOGON.BAT file. The users DO NOT see this. This
is just a status screen for you to see what NewLog is doing.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ EXPLANATION OF FEATURES AVAILABLE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0F░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

Erasing the current log file
----------------------------

If for any reason you wish to delete the current caller's log that NewLog made,
you can run NewLog using the -D switch.

Example:

        NEWLOG -N1 -D

Would use Node 1's configuration data file and delete the log.

Alternate string logging
------------------------

        To use the new feature, "alternate string logging", you must have an
extra character and an extra string that you're not doing anything with in TAG.

        What this is, exactly, is an optional "alternate" string the user can
enter (once) and then have NewLog log that string instead of their city/state
every time they logon. Some users may not want they're REAL city logged, some
may enter something funny. If you've ever logged onto a WildCat! BBS, you've
probably seen something similar to what I've added.

        If you have the required, go into Setup, edit the "Extra character
number" & "Extra string number" to the open ones that you aren't using. And
then toggle the "Use alternate string" variable on.

        Once you did that, go and add the following strings to your MSTRMSG.TXT
file located in your AFILES directory for TAG. In fact, you can copy them dir-
ect with a text editor that supports block copying/writing:

(Substitute the numbers in these to what you're using on your system!)

*USER_EXTRA_CHAR_1
Do you want something other than your city/state to show up in the log? (Y/N)
 : @@@
*

*USER_EXTRA_CHAR_1_LISTING
Use alt. string
*

*USER_EXTRA_CHAR_1_VERIFY
Use alternate string   : @@@
*

*USER_EXTRA_CHAR_1_VALID
YN
*

*USER_EXTRA_STRING_1
Enter what you want to show up instead of your city/state (if active).
Otherwise, press return at the prompt.
 : @@@
*

*USER_EXTRA_STRING_1_LISTING
String in log
*

*USER_EXTRA_STRING_1_VERIFY
String in caller's log : @@@
*

(Don't forget to compile the strings using TAGSTR.EXE!)

And then after doing that, you can add the menu commands in the Personal Data
menu so the users can change if they want it logged, and the string. You can
find the program datas/keys in your TAGD26D.ZIP documentation files. If you
don't have them, you can FREQ them from me as "TAGD26D.ZIP". (1:2410/480)

Once you've did all this, you need to go in the User Editor, and TAG *ALL* users
on your BBS. If you don't know how to do this, hit "O", and then hit "T" from
that menu, then choose option number "1. Union". This will TAG every single
user. Then, quit from the (O)ptions section (so you're just in the user editor
again), and everyone is tagged.

Then go to "/" Tagged operations, and hit "-" to clear for re-entry. And then
choose "K" and then the number of the extra character, and then "S" (I THINK)
and the number of the extra string, and it will prompt each user for both of
the fields as they logon to your system; i.e. Re-entry. :)

And finally, I'd advise adding these two questions in your H. New User Config-
uration in //SYSTEMCONFIG. I'd suggesting having the (Y/N) question just be-
fore the prompt for the string.

Also, don't forget to add two commands in your personal data change menu in
case the users want to change the options.

*** Another use for this would be if a user does NOT want their city or any-
*** thing logged, which some don't (well, the paranoid, that is).

It's a lot of work, but it's an excellent feature! Anyone using this feature
please tell be by means located at the end of this file. Give me some feed-
back on this one!

Overriding the baudrate read in from CALLERS.LOG
------------------------------------------------

   NewLog can now "override" the baudrate read in from the CALLERS.LOG file by
being run with a fourth command line parameter, that being the baudrate.

   A use for this would be to disguise the baudrate that the last user actually
was on at, or to make your modem look faster, or what ever you desire. :)

Example:

   NEWLOG -N1 -C1 16800

   Would read in NLOG1.DAT, log a caller (User #1), and change the baud rate to
16800. Please note that it automatically puts parentheses around the baud rate
you specify, and try not to make it longer than five characters or things could
get messy in your callers log.

Logging comments, events, and more!
-----------------------------------

   You can use NewLog's -L feature, which will record any text after the -L
on the command line (or in the batch file), and put it in your log. For example,
say you want "Nightly Maintenance Started" logged into your batch file just as
your maintenance batch file starts, you would do this (if this WAS the batch
file):

@ECHO OFF
C:
CD\BBS
NEWLOG -N1 -L Nightly Maintenance Started
CD\BBS\GFILES
NAMELIST
CD\BBS
BDAY
NEWLOG -N1 -L Nightly Maintenance Ended

   Another example to log "Mail Received" when your mailer (if you have one)
receives and EchoMail packet would be: (This is a part of my MAILER.BAT)

:IN_MAIL
CD\BBS
NEWLOG -N1 -L Mail Received!
CD\BBS\FD
FASTECHO TOSS
FEUTIL PURGE -Delete
FEUTIL LINK
IF EXIST C:\ECHO\INBOUND\NODEDIFF.* GOTO NODPRO
GOTO RUNFD

   There are several more possiblilties with the -L parameter; you can log it
if a user goes into a door or game, and taking that one step further, you can
log their name along with that using TAG's passed command line parameters.

@ECHO OFF
CD\BBS
NEWLOG 1 /L %3 entered TAGVote
TAGVOTE %1 %2 %3 %4
CD\BBS

Using multiple config files
---------------------------

   You may think the only reason we added the separate configuration file deal
is for the multi-node, right? Well, think again, because with this you can use
different color sets, etc. Here's an example scenario.

   Say you want the color of the /L comment that says "Nightly Maintenance
Started" different from the color of "Mail Received". Well, you can do that
using multiple configuration files.

   NEWLOG -NA -L This is in yellow! (Or whatever color you set it to in SETUP).

   NEWLOG -NB -L This is in red!    (Or whatever color you set it to in SETUP).

   That's just an idea you can use to help customize the software, and possibly
expand on it.

Using the banner file (formerly "BANNER.TXT")
---------------------------------------------

   NewLog supports a plain ASCII text file that can be read in at the beginning
of the log.

   As stated, the file is simply a plain text file placed in your main BBS
directory, that can contain any text you want; color codes, SDR codes, comments,
scores, ANYTHING.

   This feature is completely optional, but there is a default BANNER.TXT that's
included with this archive. (At least, there SHOULD be).

   All you do is place it (or make sure it's in) your Main BBS directory where
NewLog is located, and it reads it in!

   (See first time setup instructions for options on automatically centering
your banner file).

Program Maintenance
-------------------

   As of v2.5, we've elminated the need for ANY program maintenance. Period.
This eliminates the need for a nightly batch file if you weren't using one in
the first place.

   It will automatically detect the date/time of the log, and proceed to erase
it and start over for the next day without having to run a NEWLOG -Nx -D, or
copy and delete any files.

Renaming Old Logs
-----------------

   There is now a feature that will enable you to not only delete, but to Re-
name the old callers log to an external file, maybe even a printer*

   The option is in the Setup program, and is fully optional!

                         * - This has NOT been tested.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ WHAT TO LOOK FOR IN FUTURE RELEASES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0G░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

   Add a new mode of logging callers; "CALLERS.LOG" style; except CoLoRiZeD!

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ SUPPORT INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0H░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

  Thank you very much for trying NewLog, but we both know, there are going to be
bugs in the software. Please send any questions, give any bug reports to, or
call for support, to any of the following TNT support systems:

                                  Alpha Sites
                                  -----------

System Operator     Name of BBS             Fido Node    BBS Phone       Baud
--------------------------------------------------------------------------------
Joe McElmeel      - The Galaxy BBS        - 1:2410/480 - [phone] - 14.4v *
Rich Landskroener - The Emergency Scene   - 1:2410/480 - [phone] - 2400
Jonathan Blair    - The Infinite Journey  - 1:2605/630 - [phone] - 14.4v *

                                   Beta Sites
                                   ----------

System Operator     Name of BBS             Fido Node    BBS Phone       Baud
--------------------------------------------------------------------------------
Mark Watts        - The Mists of Time     - 1:2410/329 - [phone] - 14.4v *
Alex McNeilly     - Chessplayer's Forum   - 1:2410/0   - [phone] - 16.8d
Alex McNeilly     - Chessplayer's Forum   - 1:2410/278 - [phone] - 14.4h
Bob Lechtanksi    - The Genuine Daze BBS  - 1:2200/807 - [phone] - 9600v
Hawley Warren     - Egghead's Place       - 1:2410/297 - [phone] - 16.8d *
Mike Coleman      - Ground Zero!          - 1:2410/339 - [phone] - 14.4v *
Chris Bourne      - Law & Order BBS       - 1:2330/100 - [phone] - 14.4v
Steve Bishop      - The Bushwacker BBS    - 1:3610/3   - [phone] - 14.4d
Mike Lowe         - Marauder's Hideaway   - 1:112/99   - [phone] - 14.4v

                       v = v.32 / v.32bis standard.
                       h = US Robotics HST protocol.
                       d = US Robotics HST/Dual Standard.

                       * = Has latest release for FREQ as "NEWLOG".

  (Most sites have NEWLOG for FREQ, but the * denotes ones that are confirmed).

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ OTHER PRODUCTS FROM TNT SOFTWARE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0I░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

   TAG Top 15 Files - This is a complete re-write of Player's Choice Software's
                      old TOP15 written by David Mitchell.
    (Version 1.0)
                      This one supports Multi-node FILES.DIR listings, is com-
     * OUT NOW! *     piled with TAG v2.6d's structures, and has the ability to
                      "block-out" certain file boards from being looked at.

                      Who wants to see that "SEXMEUP.GIF" is the top downloaded
                      file on your system? :)

It also suports file sharing/record locking, and runs quite a bit faster than
the old TOP15 and using quite a bit less memory.

This program is in it's final stages of Beta testing; expect it soon! It is, of
course, another fine freeware product written by Joe McElmeel.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ CONTACTING THE AUTHOR  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0J░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

You can also get in contact with Joe McElmeel in the following ways:

   Joe McElmeel:
   ------------

     US Mail:

        Joe McElmeel
        18081 Koester
        Riverview, MI 48192-7416

     InterNet:

        [e-mail]
        [e-mail] -or- [e-mail]

        I also frequent the IRC under the handle "Inferno".

     BBS:

        The Galaxy BBS; [phone], Lincoln Park, MI. 14400 v.32bis/v.42bis.
        New users can access the messages, files, and NewLog on the first call.

     Networks:

        RPGNet 100:1313/501, CrossNet: 73:4100/12, SOGNet 91:7/4480 and FidoNet
        1:2410/480.

     FidoNet Echo Bases:

        FE_BETA, FE_HELP, {COMMO}, TAG, TAGMULTI, TAG_DOORS, and SRGAMES.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ ACKNOWLEDGEMENTS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0K░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

        I would like to thank the following people for their contributions to
our software group:

        o Myself, for providing the docs, distribution of NewLog, and the many
          hours of programming.

        o Jeff Witt for thinking of the name "TNT Software".

        o Richard Landskroener for starting NewLog a while back.

        o David Mitchell for letting us write under your old software group as
          well as your help in the Date routines.

        o Paul Williams for T.A.G. BBS, the record structures, and the <cough>
          constructive critcism at the Net 2410 meeting on how bad the code was
          as well as your help with the Auto-Log deleting.

╔══════════════════════════════════════════════════════════════════════════════╗
║ ░░░ A FINAL NOTE ABOUT THE ERROR FILE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0L░ ║
╚══════════════════════════════════════════════════════════════════════════════╝

        In case you haven't noticed, NewLog writes to a file (in the directory
that you ran it from) called "NEWLOG.ERR".

        If you encounter what you think is bug, please supply this file as well
as your Setup data files to me, the author.

        This is a simple text file that NewLog makes when there is an error on
the system -- feel free to delete it if you did something like typo a command
line parameter.

                                     -EOF-